Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWillian Padovani Germano <wpgermano@gmail.com>2003-06-24 11:21:17 +0400
committerWillian Padovani Germano <wpgermano@gmail.com>2003-06-24 11:21:17 +0400
commit06ee04fb05ff58e6e0a781b64100825ba7358f19 (patch)
treec90b1415ebb106090c6f94b4ee782146245bc67d /source/blender/python/api2_2x/doc/Blender.py
parenta0ea4df1ba0367657ba4e093ca0d1288d6258ba4 (diff)
* Added more doc files for epydoc and a test for the camera module.
* Moved public declarations in camera and lamp to a new file: bpy_types.h. * Fixed minor bugs in material, rgbTuple and Lamp + other minor changes. * Made part of the changes to conform to decided naming conventions.
Diffstat (limited to 'source/blender/python/api2_2x/doc/Blender.py')
-rw-r--r--source/blender/python/api2_2x/doc/Blender.py58
1 files changed, 58 insertions, 0 deletions
diff --git a/source/blender/python/api2_2x/doc/Blender.py b/source/blender/python/api2_2x/doc/Blender.py
new file mode 100644
index 00000000000..cea2d0923bf
--- /dev/null
+++ b/source/blender/python/api2_2x/doc/Blender.py
@@ -0,0 +1,58 @@
+# The Blender Module
+
+"""
+Here goes the Introduction to Blender Python
+
+Let's see::
+ - What scripting is, why have it
+ - What is Python, links
+ - More about what scripting can give us
+ - Overview of the Blender Python modules
+ - Links to Blender, Blender Python, later: script lists
+@author: The Blender Python Team
+@requires: Blender 2.28 or newer, Python 2.? (2.0, 2.1, 2.2 ???) or newer
+@version: 0.1
+@see: U{www.blender.org<http://www.blender.org>}
+@see: U{projects.blender.org<http://projects.blender.org>}
+"""
+
+def Set (request, data):
+ """
+ Update settings in Blender
+ @type request: string
+ @param request: The setting to change:
+ - 'curframe': the current animation frame
+ @type data: int
+ @param data: The new value.
+ """
+
+def Get (request):
+ """
+ Retrieve settings from Blender.
+ @type request: string
+ @param request: The setting data to be returned:
+ - 'curframe': the current animation frame
+ - 'curtime' : the current animation time
+ - 'staframe': the start frame of the animation
+ - 'endframe': the end frame of the animation
+ - 'filename': the name of the last file read or written
+ - 'version' : the Blender version number
+ @return: The requested data.
+ """
+
+def Redraw ():
+ """
+ Redraw all 3D windows
+ """
+
+def ReleaseGlobalDict (bool = None):
+ """
+ Define whether the global Python Interpreter dictionary should be cleared
+ after the script is run. Default is to clear (non-zero bool).
+ @type bool: an int, actually
+ @param bool: The flag to release (non-zero bool) or not (bool = 0) the dict.
+ if no argument is passed, this function simply returns the current
+ behavior.
+ @rtype: int
+ @return: A bool value (0 or 1) telling the current behavior.
+ """