diff options
| author | HG1 <HG1_public@gmx.net> | 2014-07-12 02:18:43 +0400 |
|---|---|---|
| committer | Mitchell Stokes <mogurijin@gmail.com> | 2014-07-12 03:00:14 +0400 |
| commit | 984d6c8677a365cf47cc6ad6c89c93b04877a948 (patch) | |
| tree | 0433fe2f7f5646d4afddca0c769c42c6cbfca56b /doc | |
| parent | 93278165937273fd0c14eb54deb1c4c25ebb1296 (diff) | |
BGE debug API and actuator
This patch adds some new debug methods to the KX_GameObject for manually adding the debug list and bge.render for controlling the debug visualization.
It also adds a new debug actuator, which allows to control the same functions.
This patch is a updated version of T33701.
Thread on Blenderartists:
http://blenderartists.org/forum/showthread.php?264745-Debug-proerties-for-added-objects-patch&p=2256018&viewfull=1#post2256018
Reviewers: moguri
Reviewed By: moguri
Differential Revision: https://developer.blender.org/D635
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/python_api/rst/bge.render.rst | 28 | ||||
| -rw-r--r-- | doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst | 20 |
2 files changed, 48 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge.render.rst b/doc/python_api/rst/bge.render.rst index 5a80b7fa5c1..9dd4057c82f 100644 --- a/doc/python_api/rst/bge.render.rst +++ b/doc/python_api/rst/bge.render.rst @@ -301,6 +301,34 @@ Functions Disable the motion blur effect. +.. function:: showFramerate(enable) + + Show or hide the framerate. + + :type enable: boolean + +.. function:: showProfile(enable) + + Show or hide the profile. + + :type enable: boolean + +.. function:: showProperties(enable) + + Show or hide the debug properties. + + :type enable: boolean + +.. function:: autoDebugList(enable) + + Enable or disable auto adding debug properties to the debug list. + + :type enable: boolean + +.. function:: clearDebugList() + + Clears the debug property list. + .. function:: setVsync(value) Set the vsync value diff --git a/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst b/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst index 215ff40577c..a6d03dee1a1 100644 --- a/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst +++ b/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst @@ -363,6 +363,18 @@ base class --- :class:`SCA_IObject` :type: float + .. attribute:: debug + + If true, the object's debug properties will be displayed on screen. + + :type: boolean + + .. attribute:: debugRecursive + + If true, the object's and children's debug properties will be displayed on screen. + + :type: boolean + .. method:: endObject() Delete this object, can be used in place of the EndObject Actuator. @@ -857,3 +869,11 @@ base class --- :class:`SCA_IObject` :return: Whether or not the action is playing :rtype: boolean + .. method:: addDebugProperty (name, debug = True) + + Adds a single debug property to the debug list. + + :arg name: name of the property that added to the debug list. + :type name: string + :arg debug: the debug state. + :type debug: boolean
\ No newline at end of file |