Cr8-xyz/blender
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

BGE api added place holder docs and CListValue docs.

Browse Source
This commit is contained in:
Campbell Barton
2009-04-07 17:54:56 +00:00
parent afb2670246
commit bdfa61fbbe
10 changed files with 549 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

228
source/gameengine/PyDoc/BL_Shader.py Normal file
View File

@@ -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
"""

39
source/gameengine/PyDoc/CListValue.py Normal file
View File

@@ -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.
"""

38
source/gameengine/PyDoc/KX_BlenderMaterial.py Normal file
View File

@@ -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
"""

28
source/gameengine/PyDoc/KX_ConstraintWrapper.py Normal file
View File

@@ -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
"""

4
source/gameengine/PyDoc/KX_GameObject.py
View File

@@ -328,13 +328,13 @@ class KX_GameObject: # (SCA_IObject)
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):

47
source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py Normal file
View File

@@ -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
"""

10
source/gameengine/PyDoc/KX_Scene.py
View File

@@ -16,14 +16,14 @@ class KX_Scene:
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"]
# get the first object in the scene.
obj = scene.getObjectList()[0]
obj = scene.objects[0]
Example::
# Get the depth of an object in the camera view.
@@ -40,7 +40,7 @@ class KX_Scene:
@ivar name: The scene's name
@type name: string
@ivar objects: A list of objects in the scene.
@type objects: list [L{KX_GameObject}]
@type objects: L{CListValue<CListValue.CListValue>} of L{KX_GameObject<KX_GameObject.KX_GameObject>}
@ivar active_camera: The current active camera
@type active_camera: L{KX_Camera}
@ivar suspended: True if the scene is suspended.

4
source/gameengine/PyDoc/KX_TouchSensor.py
View File

@@ -17,7 +17,7 @@ class KX_TouchSensor(SCA_ISensor):
@ivar objectHit: The last collided object. (Read Only)
@type objectHit: L{KX_GameObject} or None
@ivar objectHitList: A list of colliding objects. (Read Only)
@type objectHitList: list
@type objectHitList: L{CListValue<CListValue.CListValue>} of L{KX_GameObject<KX_GameObject.KX_GameObject>}
"""
#--The following methods are deprecated, please use properties instead.
@@ -53,7 +53,7 @@ class KX_TouchSensor(SCA_ISensor):
Only objects that have the requisite material/property are listed.
@rtype: list [L{KX_GameObject}]
@rtype: L{CListValue<CListValue.CListValue>} of L{KX_GameObject<KX_GameObject.KX_GameObject>}
"""
def getTouchMaterial():
"""

158
source/gameengine/PyDoc/KX_VehicleWrapper.py Normal file
View File

@@ -0,0 +1,158 @@
class KX_VehicleWrapper: # (PyObjectPlus)
"""
KX_VehicleWrapper
All placeholders have a __ prefix
"""
def __addWheel(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __applyBraking(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __applyEngineForce(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getConstraintId(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getConstraintType(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getNumWheels(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getWheelOrientationQuaternion(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getWheelPosition(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __getWheelRotation(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setRollInfluence(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setSteeringValue(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setSuspensionCompression(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setSuspensionDamping(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setSuspensionStiffness(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""
def __setTyreFriction(val):
"""
TODO - Description
@param val: the starting frame of the animation
@type val: float
@rtype: integer
@return: TODO Description
"""

4
source/gameengine/PyDoc/bge_api_validate_py.txt
View File

@@ -85,7 +85,7 @@ for type_name in sorted(type_members.keys()):
if PRINT_OK:
print "type: %s" % type_name
except:
print "missing: %s - %s" % (type_name, str(members))
print "missing: %s - %s" % (type_name, str(sorted(members)))
continue
reload(mod) # incase were editing it
@@ -93,7 +93,7 @@ for type_name in sorted(type_members.keys()):
try:
type_class = getattr(mod, type_name)
except:
print "missing class: %s.%s - %s" % (type_name, type_name, str(members))
print "missing class: %s.%s - %s" % (type_name, type_name, str(sorted(members)))
continue
for member in sorted(members):