diff options
author | Campbell Barton <ideasman42@gmail.com> | 2012-11-22 10:04:12 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2012-11-22 10:04:12 +0400 |
commit | b7f5c1c121724964c6c2269c05eedd04a78e7a74 (patch) | |
tree | 066c52cda2330e8fe0adb4e8f85c39ba9fc0bbef /doc | |
parent | 89b0b0516e9e46284f445a33be1887af499c251f (diff) |
more bge reference api docstrings, leaving KX_FontObject and KX_NavMeshObject as TODO.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/python_api/rst/bge.logic.rst | 15 | ||||
-rw-r--r-- | doc/python_api/rst/bge.types.rst | 44 |
2 files changed, 59 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge.logic.rst b/doc/python_api/rst/bge.logic.rst index b28c9603ef1..95af6cb58a3 100644 --- a/doc/python_api/rst/bge.logic.rst +++ b/doc/python_api/rst/bge.logic.rst @@ -324,6 +324,21 @@ General functions .. warning: Not implimented yet +.. function:: getExitKey() + + Gets the key used to exit the game engine + + :return: The key (defaults to :mod:`bge.events.ESCKEY`) + :rtype: int + +.. function:: setExitKey(key) + + Sets the key used to exit the game engine + + :arg key: A key constant from :mod:`bge.events` + :rtype key: int + + ***************** Utility functions ***************** diff --git a/doc/python_api/rst/bge.types.rst b/doc/python_api/rst/bge.types.rst index c0a5eeb55d1..959dae0cf72 100644 --- a/doc/python_api/rst/bge.types.rst +++ b/doc/python_api/rst/bge.types.rst @@ -633,6 +633,14 @@ Types :type: string + +.. class:: KX_SteeringActuator(SCA_IActuator) + + SteeringActuator for navigation. + + TODO. + + .. class:: CListValue(CPropValue) This is a list like object used in the game engine internally that behaves similar to a python list in most ways. @@ -698,6 +706,24 @@ Types KX_BlenderMaterial + .. attribute:: shader + + The materials shader. + + :type: :class:`BL_Shader` + + .. attribute:: blending + + Ints used for pixel blending, (src, dst), matching the setBlending method. + + :type: (integer, integer) + + .. attribute:: material_index + + The material's index. + + :type: integer + .. method:: getShader() Returns the material's shader. @@ -1223,6 +1249,13 @@ Types :type: :class:`CListValue` of :class:`KX_GameObject`'s + .. attribute:: life + + The number of seconds until the object ends, assumes 50fps. + (when added with an add object actuator), (read-only). + + :type: float + .. method:: endObject() Delete this object, can be used in place of the EndObject Actuator. @@ -2176,6 +2209,17 @@ Types :type: list of strings + +.. class:: KX_FontObject(KX_GameObject) + + TODO. + + +.. class:: KX_NavMeshObject(KX_GameObject) + + TODO. + + .. class:: KX_ObjectActuator(SCA_IActuator) The object actuator ("Motion Actuator") applies force, torque, displacement, angular displacement, |