diff options
author | Porteries Tristan <republicthunderbolt9@gmail.com> | 2015-06-15 22:20:47 +0300 |
---|---|---|
committer | Porteries Tristan <republicthunderbolt9@gmail.com> | 2015-06-15 22:46:56 +0300 |
commit | 1c707a239258996e4f5a5873517ff34564eaf8da (patch) | |
tree | 668250701eb195acfb96982da934be5874323029 /doc/python_api/rst | |
parent | 124b25cf9d47837e384ade566f03e84186535967 (diff) |
BGE: Fix T43918: adding submodule bge.app including attribute version.
This patch adds the submodule app to bge. apps contains constants similar to bpy.app, particularly version (tuple of three ints like 2.75.1).
It was requested in T43918 and set as TODO.
The patch also adds rst doc for the module.
Reviewers: moguri, kupoman, lordloki, panzergame, campbellbarton
Reviewed By: lordloki, panzergame, campbellbarton
Subscribers: marcino15
Projects: #game_logic, #game_python, #game_engine
Differential Revision: https://developer.blender.org/D1348
Diffstat (limited to 'doc/python_api/rst')
-rw-r--r-- | doc/python_api/rst/bge.app.rst | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge.app.rst b/doc/python_api/rst/bge.app.rst new file mode 100644 index 00000000000..a0c2cf36314 --- /dev/null +++ b/doc/python_api/rst/bge.app.rst @@ -0,0 +1,47 @@ + +Application Data (bge.app) +========================== + +Module to access application values that remain unchanged during runtime. + +.. module:: bge.app + +.. data:: version + + The Blender/BGE version as a tuple of 3 ints, eg. (2, 75, 1). + + .. note:: Version tuples can be compared simply with (in)equality symbols; + for example, ``(2, 74, 5) <= (2, 75, 0)`` returns True (lexical order). + + :type: tuple of three ints + +.. data:: version_string + + The Blender/BGE version formatted as a string, eg. "2.75 (sub 1)". + + :type: str + +.. data:: version_char + + The Blender/BGE version character (for minor releases). + + :type: str + +.. data:: has_texture_ffmpeg + + True if the BGE has been built with FFmpeg support, enabling use of :class:`~bge.texture.ImageFFmpeg` and :class:`~bge.texture.VideoFFmpeg`. + + :type: bool + +.. data:: has_joystick + + True if the BGE has been built with joystick support. + + :type: bool + +.. data:: has_physics + + True if the BGE has been built with physics support. + + :type: bool + |