diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/python_api/rst/bge.app.rst | 47 | ||||
-rw-r--r-- | doc/python_api/sphinx_doc_gen.py | 3 |
2 files changed, 50 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 + diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py index e5ce4c76142..32776ef29f3 100644 --- a/doc/python_api/sphinx_doc_gen.py +++ b/doc/python_api/sphinx_doc_gen.py @@ -234,6 +234,7 @@ else: EXCLUDE_MODULES = [ "aud", "bge", + "bge.app" "bge.constraints", "bge.events", "bge.logic", @@ -1669,6 +1670,7 @@ def write_rst_contents(basepath): fw(" bge.texture.rst\n\n") fw(" bge.events.rst\n\n") fw(" bge.constraints.rst\n\n") + fw(" bge.app.rst\n\n") # rna generated change log fw(title_string("API Info", "=", double=True)) @@ -1825,6 +1827,7 @@ def copy_handwritten_rsts(basepath): "bge.texture", "bge.events", "bge.constraints", + "bge.app", "bgl", # "Blender OpenGl wrapper" "gpu", # "GPU Shader Module" |