Revision: 19586
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=19586
Author: campbellbarton
Date: 2009-04-07 19:54:56 +0200 (Tue, 07 Apr 2009)
Log Message:
-----------
BGE api added place holder docs and CListValue docs.
Modified Paths:
--------------
trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
trunk/blender/source/gameengine/PyDoc/KX_Scene.py
trunk/blender/source/gameengine/PyDoc/KX_TouchSensor.py
trunk/blender/source/gameengine/PyDoc/bge_api_validate_py.txt
Added Paths:
-----------
trunk/blender/source/gameengine/PyDoc/BL_Shader.py
trunk/blender/source/gameengine/PyDoc/CListValue.py
trunk/blender/source/gameengine/PyDoc/KX_BlenderMaterial.py
trunk/blender/source/gameengine/PyDoc/KX_ConstraintWrapper.py
trunk/blender/source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py
trunk/blender/source/gameengine/PyDoc/KX_VehicleWrapper.py
Added: trunk/blender/source/gameengine/PyDoc/BL_Shader.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/BL_Shader.py
(rev 0)
+++ trunk/blender/source/gameengine/PyDoc/BL_Shader.py 2009-04-07 17:54:56 UTC
(rev 19586)
@@ -0,0 +1,228 @@
+class BL_Shader: # (PyObjectPlus)
+ """
+ BL_Shader GLSL shaders.
+
+ All placeholders have a __ prefix
+ """
+
+ def __setUniformfv(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+
+ def __delSource(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __getFragmentProg(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __getVertexProg(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __isValid(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setAttrib(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setNumberOfPasses(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setSampler(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setSource(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniform1f(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniform1i(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniform2f(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniform2i(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniform3f(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniform3i(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniform4f(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniform4i(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniformDef(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniformMatrix3(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniformMatrix4(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setUniformiv(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __validate(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
Added: trunk/blender/source/gameengine/PyDoc/CListValue.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/CListValue.py
(rev 0)
+++ trunk/blender/source/gameengine/PyDoc/CListValue.py 2009-04-07 17:54:56 UTC
(rev 19586)
@@ -0,0 +1,39 @@
+class CListValue: # (PyObjectPlus)
+ """
+ CListValue
+
+ This is a list like object used in the game engine internally that
behaves similar to a python list in most ways.
+
+ As well as the normal index lookup.
+ C{val= clist[i]}
+
+ CListValue supports string lookups.
+ C{val= scene.objects["OBCube"]}
+
+ Other operations such as C{len(clist), list(clist), clist[0:10]} are
also supported.
+ """
+ def append(val):
+ """
+ Add an item to the list (like pythons append)
+
+ Warning: Appending values to the list can cause crashes when
the list is used internally by the game engine.
+ """
+
+ def count(val):
+ """
+ Count the number of instances of a value in the list.
+
+ @rtype: integer
+ @return: number of instances
+ """
+ def index(val):
+ """
+ Return the index of a value in the list.
+
+ @rtype: integer
+ @return: The index of the value in the list.
+ """
+ def reverse(val):
+ """
+ Reverse the order of the list.
+ """
\ No newline at end of file
Added: trunk/blender/source/gameengine/PyDoc/KX_BlenderMaterial.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_BlenderMaterial.py
(rev 0)
+++ trunk/blender/source/gameengine/PyDoc/KX_BlenderMaterial.py 2009-04-07
17:54:56 UTC (rev 19586)
@@ -0,0 +1,38 @@
+class KX_BlenderMaterial: # (PyObjectPlus)
+ """
+ KX_BlenderMaterial
+
+ All placeholders have a __ prefix
+ """
+
+ def __getShader(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+
+ def __setBlending(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __getMaterialIndex(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
Added: trunk/blender/source/gameengine/PyDoc/KX_ConstraintWrapper.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_ConstraintWrapper.py
(rev 0)
+++ trunk/blender/source/gameengine/PyDoc/KX_ConstraintWrapper.py
2009-04-07 17:54:56 UTC (rev 19586)
@@ -0,0 +1,28 @@
+class KX_ConstraintWrapper: # (PyObjectPlus)
+ """
+ KX_ConstraintWrapper
+
+ All placeholders have a __ prefix
+ """
+ def __getConstraintId(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+
+ def __testMethod(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+
Modified: trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_GameObject.py 2009-04-07
17:17:47 UTC (rev 19585)
+++ trunk/blender/source/gameengine/PyDoc/KX_GameObject.py 2009-04-07
17:54:56 UTC (rev 19586)
@@ -328,13 +328,13 @@
def getChildren():
"""
Return a list of immediate children of this object.
- @rtype: list
+ @rtype: L{CListValue<CListValue.CListValue>} of
L{KX_GameObject<KX_GameObject.KX_GameObject>}
@return: a list of all this objects children.
"""
def getChildrenRecursive():
"""
Return a list of children of this object, including all their
childrens children.
- @rtype: list
+ @rtype: L{CListValue<CListValue.CListValue>} of
L{KX_GameObject<KX_GameObject.KX_GameObject>}
@return: a list of all this objects children recursivly.
"""
def getMesh(mesh):
Added: trunk/blender/source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py
(rev 0)
+++ trunk/blender/source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py
2009-04-07 17:54:56 UTC (rev 19586)
@@ -0,0 +1,47 @@
+class KX_PhysicsObjectWrapper: # (PyObjectPlus)
+ """
+ KX_PhysicsObjectWrapper
+
+ All placeholders have a __ prefix
+ """
+ def __setActive(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+
+ def __setAngularVelocity(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setLinearVelocity(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
+ def __setPosition(val):
+ """
+ TODO - Description
+
+ @param val: the starting frame of the animation
+ @type val: float
+
+ @rtype: integer
+ @return: TODO Description
+ """
Modified: trunk/blender/source/gameengine/PyDoc/KX_Scene.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_Scene.py 2009-04-07 17:17:47 UTC
(rev 19585)
+++ trunk/blender/source/gameengine/PyDoc/KX_Scene.py 2009-04-07 17:54:56 UTC
(rev 19586)
@@ -16,14 +16,14 @@
scene = GameLogic.getCurrentScene()
# print all the objects in the scene
- for obj in scene.getObjectList():
- print obj.getName()
+ for obj in scene.objects:
+ print obj.name
# get an object named 'Cube'
- obj = scene.getObjectList()["OBCube"]
+ obj = scene.objects["OBCube"]
@@ Diff output truncated at 10240 characters. @@
_______________________________________________
Bf-blender-cvs mailing list
[email protected]
http://lists.blender.org/mailman/listinfo/bf-blender-cvs
